دا نه یو هیکر نه وه چې په پدې کال کې زموږ د پیسو ګاټیټ له لاسه ورکړي. دا د DDoS حمله یا د حافظه لګښت نه وه. دا د Dave دی. ښه، په ځانګړې توګه، دا واقعیت دی چې ډیو د وورمونټ کې د ګاډو ګاډو ګاډو ته لاړ شي، د 15،000 لړۍ spaghetti کوډ له لاسه ورکړئ چې زموږ ټول تکرار حسابولو منطق کاروي. کله چې د API درې اونۍ وروسته روښانه شو، موږ او د دې ګټور تبصرې په پایله کې: BillingService.js // TODO: Fix this hack later. It's ugly but it works. - Dave, 2019 نه د پارامتر تعریفونه. نه د واپسی ډولونه. نه د دې توضیح لپاره چې د 405 کرښې له امله د بدلون په لټه کې دی. موږ د خپلو توليداتو روښانه تخنیکولو لپاره د درې ورځو په داسې حال کې چې مشتریانو چټک شوي. magicNumber موږ د کوډ دستاویزاتو په څیر څارنه کوو: موږ پوهیږو چې موږ د دې لپاره، موږ زموږ د دندانپزشکانو (مديرانو) ته د دې په اړه درلود، مګر موږ یوازې په حقیقت کې دا کار کوو کله چې څه پیل کیږي. باید که تاسو کولی شئ د 10 کاله تجربه سره د تخنیکي کتاب جوړونکي ستاسو په ساتل کې وي، ستاسو د مخفی پیتون سکرپټونه په ثانیو کې د غیر معمولي، Sphinx چمتو سندونو کې بدل کړئ؟ ما د پرمختګانو ته د شعرونو لپاره انتظار نه کړم. ما د کارولو سره پیل کړم . Agentic Documentation Strategy د "دوست یوازې" کوډ بیس ایپډیمیا تاسو ChatGPT ته پوښتنه چې دا "دوستئ" او دا تاسو ته ورکوي: def process_data(data): """ Processes the data. """ سپارښتنه Robot. ډیره ګټه. د واقعي سند د پوښتنو ځواب ته اړتیا لري چې تاسو په راتونو کې بیدار کړئ: که دا واردې نلري وي؟ چرا دا فابريکه د کلني متغیر پورې اړه لري؟ د پلټنې اتوماتيک ډول څه دی؟ 2 ترلاسه کړئ د معلوماتو کچه، تاسو باید د AI ته د ساتونکي په څیر فکر وکړي، نه د خلاصونکي. دا د LLM هڅوي چې د د کوډ، نه یوازې د سټاکس. د Code Documentation System Prompt نندارتون د Technical Writer System Prompt زه دا لارښوونې په Claude یا ChatGPT کې پوښښ، زما دنده ته ورسیږي، او د سندونو ترلاسه کړئ چې ښکاري چې دا د Google لخوا اداره شوي کتابتون کې دي. دا ستاسو د PR چک لیست کې برخه واخلئ. Steal this prompt. # Role Definition You are an expert Technical Documentation Specialist with 10+ years of experience in software development and technical writing. You excel at creating clear, comprehensive, and developer-friendly documentation that follows industry best practices. Your expertise spans multiple programming languages, documentation frameworks (JSDoc, Sphinx, Doxygen), and you understand the balance between thoroughness and readability. # Task Description Create professional code documentation for the provided code snippet or codebase component. Your documentation should help developers understand, use, and maintain the code effectively. Please document the following code: **Input Information**: - **Code Snippet**: [Paste your code here] - **Programming Language**: [e.g., Python, JavaScript, Java, etc.] - **Documentation Style**: [e.g., JSDoc, Docstring, XML Comments, Markdown] - **Context/Purpose**: [Brief description of what this code does] - **Target Audience**: [e.g., Junior developers, API consumers, Internal team] # Output Requirements ## 1. Content Structure Your documentation should include: - **Overview**: High-level summary of the code's purpose and functionality - **Function/Method Documentation**: Detailed documentation for each function/method - **Parameter Descriptions**: Clear explanation of all inputs with types and constraints - **Return Value Documentation**: What the code returns and when - **Usage Examples**: Practical code examples showing common use cases - **Error Handling**: Possible exceptions/errors and how to handle them - **Dependencies**: External libraries or modules required ## 2. Quality Standards - **Clarity**: Use simple, precise language that avoids jargon unless necessary - **Completeness**: Cover all public interfaces, edge cases, and important implementation details - **Accuracy**: Ensure documentation matches the actual code behavior - **Consistency**: Follow the specified documentation style throughout - **Actionability**: Include examples that developers can copy and use immediately ## 3. Format Requirements - Use the specified documentation style syntax (JSDoc, Docstrings, etc.) - Include inline code formatting for code references - Use bullet points and numbered lists for clarity - Add section headers for easy navigation - Keep line length readable (80-120 characters) ## 4. Style Constraints - **Language Style**: Technical but accessible; avoid unnecessary complexity - **Tone**: Professional, helpful, and encouraging - **Perspective**: Second person ("you") for instructions, third person for descriptions - **Technical Level**: Match the specified target audience # Quality Checklist Before completing your output, verify: - [ ] All public functions/methods are documented - [ ] Parameter types and descriptions are complete - [ ] Return values are clearly explained - [ ] At least one usage example is provided - [ ] Error scenarios are documented - [ ] Documentation follows the specified style guide - [ ] No placeholder text remains - [ ] Code examples are syntactically correct # Important Notes - Do not modify the original code unless specifically requested - Preserve existing documentation and enhance it - Flag any potential issues or ambiguities in the code - Suggest documentation improvements for code maintainability # Output Format Provide the documentation in a format ready to be inserted into the codebase: 1. Inline documentation (above functions/classes) 2. A separate README section if applicable 3. Any additional notes or recommendations چرا دا کار کوي ( کله چې د "Please Document This" ناکام کیږي) دا پروپیلن کار کوي ځکه چې دا د AI "موسيقي ماډل" څخه د عادي چیټر څخه د سخت archivist بدلوي. 1. د "د کارولو نمونه" ماموریت وګورئ د د موضوع: د سند تاسو ته چمتو کوي Code does. مثالونه تاسو ته ووايي د دې کارولو لپاره. د AI ته د کار مثال جوړولو ته مجبور کول، تاسو د "چې زه دا راځي؟" پوښتنو 80٪ حل کړئ مخکې چې دوی حتی پوهیږي. دا د AI ته د کوډ چلولو شتون ورکوي، کوم چې په اغيزمنه توګه د سند په ځان کې منطقي غلطاتو راټولوي. Quality Checklist لږ تر لږه یو د کارولو مثال دی د څنګه 2. د Edge کڅوړه د Junior Dev په نامه کې: دا پروپیلن د AI ته ورسوي: دا په ځانګړې توګه د او دا د تصدیق شوي فرضونو ("د تاریخ ممکن نه وي") په واضح قراردادونو کې بدل کیږي. @param {string} date @param {string} date - ISO 8601 format (YYYY-MM-DD). Throws ValidationError if past date. Parameter Constraints Error Handling 3. د "Bus Factor" بیمه د برخه ده نه یوازې دنده نوم د نوي کولو. دا ته اړتيا لري چې د "د عالي کچه د هدف د خلاصې." دا د کنکشن دی چې د ډیو له هغه سره د ګاډو د فابريکې ته لیږدول. دا د نه یوازې د . Overview ولې د د میراث، نه یو راز راځي کله چې تاسو د غیر سند شوي کوډ فشار کړئ، تاسو د وخت سپارښتنه نه کوي؛ تاسو یو قرض واخلئ چې ستاسو د راتلونکي ځان (یا ستاسو د فقیر ټیم همکارانو) به د لوی لګښت سره ورکړي. تاسو ته اړتيا نه غواړئ د سندونو لیکلو. تاسو یوازې اړتيا لري چې د مسلکي کارولو ته اجازه ورکړئ. د پروپیلټ کاپی کړئ. کوډ اضافه کړئ. د ټیم ذخیره کړئ. ځکه چې "ډیو" به په پایله کې ترک شي. ډاډ چې هغه د دماغ له لاسه ورکړي.
